home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / fcpo.arc / FCPO1.DOC < prev    next >
Text File  |  1985-09-07  |  21KB  |  504 lines
  1.                FCPO - Electronic Filing Cabinet System
  2.                                09/01/85
  3.                           Revised: 09/07/85
  4.  
  5.                Another DarwinWare brought to you by ...
  6.  
  7.                             P. L. Olympia
  8.                          Darwin Systems, Inc.
  9.                            17 Thorburn Road
  10.                        Gaithersburg, MD  20878
  11.        Voice: 301-251-0497   BBS: 301-963-5249 (soon to change)
  12.  
  13.  
  14. NOTE: Version 1.0 eliminates the problem in the beta version where the
  15.       program pukes during list-to-printer operation in the FIND opt.
  16.  
  17.                             WHAT IS FCPO?
  18.                             -------------
  19.  
  20.      FCPO  is an electronic filing cabinet system that allows  you  to 
  21. file   away  and  retrieve  anything  you  like.    It  is  a   unique 
  22. implementation  of  the dBASE environment that solves the problems  in 
  23. relational-type data bases where you are constrained  by a  predefined 
  24. set of tables of predetermined length.   If nothing else, look at this 
  25. program as an educational and "technique" tool.
  26.  
  27.      The program does NOT need dBASE to run.
  28.  
  29.      If  you  need  to track any items of variable  length,  get  them 
  30. quickly,  and are tired of dBASE memo field limitations,  this program 
  31. is for you.
  32.  
  33.      Quick summary of features:
  34.  
  35.  o   Items  that you file can be of variable length.  They may  be  as 
  36.      short as a few characters or as long as ONE BILLION (that's a BIG 
  37.      B) lines long.  In principle, even the 1 billion is an artificial 
  38.      constraint that I can raise as long as you have the disk space or 
  39.      the dire need.
  40.  
  41.  o   Items may be entered into the filing cabinet either by way of the 
  42.      keyboard  or  imported  from  an  external  text  file,   perhaps 
  43.      downloaded  from  a  mainframe or  created  by  another  software 
  44.      package.
  45.  
  46.  o   Similarly,  you  may  export selected items to  another  software 
  47.      including your word-processor for inclusion in your documents.
  48.  
  49.  o   You  may assign any set of keys to an item that will fit on a 79-
  50.      character line.   You may then select or retrieve items using any
  51.      group or characters or substring on that key line.
  52.  
  53.  o   All data entry and edit operations use formatted screens with the 
  54.      commands of dBASE and WordStar.
  55.  
  56.  o   All  of  its files are compatible with dBASE  III's  DBF  format. 
  57.      Thus,  if you should ever need to, you can massage the data using 
  58.      dBASE as well as FCPO.
  59.  
  60.  o   You may have any number of filing cabinets active at any time.
  61.  
  62.  
  63.      Although  FCPO  can  be used easily to  maintain  your  customer, 
  64. vendor  or  contact  list of phone numbers,  you are better  off  with 
  65. something like Sidekick if all you have is a few items.
  66.  
  67.  
  68.                            A LITTLE HISTORY
  69.                            ----------------
  70.  
  71.      I  originally  wrote this program in 1980 using dBASE II  version 
  72. 2.02 on a CP/M micro.   I wrote it for myself to keep track of all  of 
  73. the  articles in computer publications to which I subscribed (25 then, 
  74. more than 80 now).   I needed a system to record article abstracts  of 
  75. varying  length.   I  also  used  it to keep  track  of  new  computer 
  76. products, including prices, vendors and summary descriptions.
  77.  
  78.      In 1982, the system was used to track proposals and projects of a 
  79. grant-funding  institution.   That same institution used the system to 
  80. produce  a camera-ready copy of a project-funding summary  book  which 
  81. included project abstracts.
  82.  
  83.      Clearly,  these are only two examples of the system's uses.  Have 
  84. a little imagination and you'll find all kinds of uses for it.
  85.  
  86.  
  87.  
  88.  
  89.                   DISCLAIMER AND DISTRIBUTION POLICY
  90.                   ----------------------------------
  91.  
  92.      This program is NOT public domain.  It is being distributed under 
  93. the  UserWare-like concept.   You are granted a limited license to use 
  94. it  for  evaluation.   If you use it and find it  of  value,  you  are 
  95. encouraged to send in your donation of what you perceive is its worth.  
  96. $30 is suggested.  Please do not send more than a million dollars as I 
  97. don't have the time to count them.  
  98.  
  99.      Sysops  who  put  this  software up on their  BBS  for  users  to 
  100. download  do NOT need to make any contribution,  in recognition of the 
  101. mostly thankless jobs they do.  
  102.  
  103.      If you choose not to contribute,  you may destroy your copy of the 
  104. program  or  give  it away to your friends (or  foes,  if  you  really 
  105. dislike  them  that much).   All commercial uses of this  software are
  106. prohibited.   Write me if you are thinking of that.  I am a reasonable 
  107. person who can't count to 1 million.
  108.  
  109.      You  should really join the UserWare experiment where you get  to 
  110. use  the  software first and make a contribution only if  it  fulfills 
  111. your need.   That concept benefits everybody.   If it fails, your only 
  112. alternative  is high-priced software whose advertising cost   is  many 
  113. times  over the product's development costs or value.   The choice  is 
  114. yours.  If this does not work for me, FCPO will be my last UserWare.
  115.  
  116.      What  do  you  get for  your  contribution?   Mainly  my  undying 
  117. gratitude,  special  treatment  and  privileges  at  my  BBS,  and  my 
  118. attention  to  any problems you may have.   I also hope to send you  a 
  119. disk with a more detailed manual, including guidelines on how to fully 
  120. interface this program and its data with dBASE III and other software. 
  121. This documentation is necessarily brief to cut down on disk space.
  122.  
  123.      The  FCPO  package  may  be freely distributed  so  long  as  its 
  124. components are distributed together and in unmodified form.   Some  of 
  125. you  guys  out there should resist the temptation of patching in  your 
  126. names in the program. Listen to your conscience.
  127.  
  128.      I have spent several weeks of my life to insure that this program 
  129. works as expected.   To my knowledge, the program has no bugs but I am 
  130. not  necessarily  as  inventive  as others (you  never  know).   I  am 
  131. obligated  to tell you right here that I will NOT be  responsible  for 
  132. any heartburn this program may cause you.   It has not caused me any - 
  133. so I hope you are as lucky.
  134.  
  135.      I do appreciate any feedback about this program from anyone, even 
  136. non-contributors (ahem!).
  137.  
  138.  
  139.  
  140.  
  141.                              REQUIREMENTS
  142.                              ------------
  143.  
  144.      An IBM PC or close compatible with at least one disk drive,  126K 
  145. TPA  (Transient  Program  Area).   A  printer and  color  monitor  are 
  146. recommended.  The program was fully tested on a color monitor.
  147.  
  148.      Your  CONFIG.SYS  file must have BUFFERS set at 20 at  least  and 
  149. FILES to 24 at least. If you don't have a CONFIG.SYS file create it as 
  150. an ASCII file (even with EDLIN), with the following lines:
  151.  
  152.           FILES=24
  153.           BUFFERS=20
  154.  
  155. Note  that the CONFIG.SYS file must be in your boot drive and is  read 
  156. only  during bootup.  If you create it,  reboot the system and  you're 
  157. set.
  158.  
  159.  
  160.                              LIMITATIONS
  161.                              -----------
  162.  
  163.      None. Except what you bring to it.  Oooops!
  164.  
  165.      Seriously,   your   only  limitation  is  disk  space  and   your 
  166. imagination.   Remember  that the 1 billion record limit is  something 
  167. that can be raised - I just had to set it at something.
  168.  
  169.  
  170.                        WHAT ARE IN THE PACKAGE?
  171.                        ------------------------
  172.  
  173. FCPO.EXE       The filing cabinet program
  174.  
  175. FCPOCNF.DBF    Configuration file. The program needs it to run.
  176.  
  177. FCSAMP.DBF     Sample  file  cabinet data base.  You will need  it  to 
  178.                follow  the QUICK START instructions and to build  your 
  179.                own (first) filing cabinet.
  180.  
  181. FCSAMPK.DBF    Key to the sample filing cabinet. No key, no go.
  182.  
  183. FCPO.DOC       You  are reading it.  This is an abbreviated manual  to 
  184.                cut down on disk space.
  185.  
  186.  
  187.                               HOW TO RUN
  188.                               ----------
  189.  
  190.      Copy  the  program  files  to your hard  disk   or  to  a  backup 
  191. diskette.   You should always keep a backup copy just in case disaster 
  192. strikes.  The program always needs FCPOCNF.DBF and will look for the 
  193. sample  files  FCSAMP.DBF and FCSAMPK.DBF the very first time you  run 
  194. it.  You  won't need the sample files after you build your own  filing 
  195. cabinet(s).   In fact, this program remembers which filing cabinet you 
  196. used last time and will look for it on startup.
  197.  
  198.      The  program works much better on a hard disk or RAM  disk.   The 
  199. data files may reside in a remote drive.
  200.  
  201.      At the DOS prompt, type FCPO:
  202.  
  203.           C>fcpo
  204.  
  205.      After a 2-second animated welcome screen,  the program looks  for 
  206. FCPOCNF.DBF and reads that for its setup environment.   After it finds 
  207. all  the files it needs,  you will be presented with a Main Menu.  All 
  208. menu options are described below.
  209.  
  210.      To exit the program and return to DOS, pick "X" at the Main Menu.
  211.  
  212.  
  213.                              QUICK START
  214.                              -----------
  215.  
  216.      The  system is menu-driven and is easy to  follow.   All  actions 
  217. flow from and to a Main Menu, shown below:
  218.  
  219. ----------------------------------------------------------------------------
  220. FCPO 0.1 - Electronic Filing Cabinet              Thanks for your support.
  221.                                                   (c) 1982,85  P.L. Olympia
  222. ----------------------------------------------------------------------------
  223. Cabinet:  FCSAMP.DBF                                        Today:  09/01/85
  224.                          M A I N   M E N U
  225.  
  226.  
  227.  DATA ENTRY/EDIT                       OUTPUT
  228.  ---------------                       ------
  229.   A -> Add data/key                      L -> List all keys
  230.   E -> Edit data/key                     F -> Find Data
  231.   I -> Import data from file             P -> exPort data to file
  232.  
  233.  
  234.  SETUP                                 OTHER
  235.  -----                                 -----
  236.    C -> Change Default Parameters        R -> Reorganize keys
  237.    B -> Build new Filing Cabinet         X -> eXit this program
  238.  
  239.  
  240.                      Pick a letter .... _
  241. ----------------------------------------------------------------------------
  242.  
  243. L>IST KEYS
  244.  
  245.      First, pick "L" to list the first 50 characters of keys to all of 
  246. the items.  You will find that several of the items in the sample file 
  247. have a key of "DBASE".
  248.  
  249.  
  250. F>IND DATA
  251.  
  252.      When  the  Main  Menu reappears,  pick "F" to find any  item  you 
  253. like and display that on the screen.   You will be presented with  the 
  254. following  selection  screen  on  which  you  specify  your  selection 
  255. criteria.
  256.  
  257. ----------------------------------------------------------------------------
  258. Cabinet:  FCSAMP.DBF                                        Today:  09/01/85
  259.  
  260.                    SPECIFY SELECTION CRITERIA
  261.  
  262. You may select records by a combination of keys or date range when the
  263. the data were entered.  Leaving all fields blank means you want everything;
  264. this is not recommended unless you have plenty of time.
  265.  
  266.  
  267.        Key substring wanted ---------------------   DBAS___________
  268.        (don't use single quote)
  269.  
  270.        DATE RANGE WHEN DATA WERE ENTERED
  271.          From which date ------------------------   __/__/__
  272.          To which date --------------------------   __/__/__
  273.  
  274. ----------------------------------------------------------------------------
  275.  
  276.      You  may  select any item by any combination of key substring  or 
  277. date range when the data were filed.  For now, type the substring DBAS
  278. on  the "Key substring wanted" prompt.   Then press PgDn or CTRL-W  to 
  279. terminate the data entry (leaving date fields blank).  
  280.  
  281.      What you have just done is ask for a screen display of all  items 
  282. in  the  data  base (one at a time) whose keys contain  the  substring 
  283. "DBAS".   The file cabinet items will be shown to you one screen at  a 
  284. time.   There  is a way to route the display directly to the  printer. 
  285. We'll cover that later.
  286.  
  287.  
  288. E>DIT DATA
  289.  
  290.      At the Main Menu,  pick "E" to edit data.   You will be presented 
  291. with  the data selection screen again (pre-filled with the last set of 
  292. criteria  you used).   If you want to EDIT all of the same  items  you 
  293. have  just seen displayed with the F>ind command,  just press PgDn (or 
  294. CTRL-W) at the selection screen.
  295.  
  296.      The first item that satisfies the selection criteria and its  key 
  297. will be presented to you. Like this:
  298.  
  299. ----------------------------------------------------------------------------
  300. Key expression shown below.                            Date Entered: 09/01/85
  301. DBMEMOPO DBASE III UTIL MEMO <$50  SMUGWARE DBT DBF
  302.  
  303.   DBMEMOPO is a utility program that allows you to load text files created
  304. elsewhere (even a mainframe) into your dBASE III memo fields. It also
  305. frees up unused space in your dBASE DBT file. All functions are done in
  306. DOS and does not require dBASE III.  Additional features that will be
  307. added later will be ... search memo fields for substring along with a
  308. display of selected DBF fields ... and report facility with MEMO.
  309.  
  310.   Program requires a donation of $30 (introductory price). A free demo 
  311. package can be downloaded from the SMUG BBS, 301-963-5249, 24 hrs, 
  312. 1200/2400 bps.
  313.  
  314. For more info, write or call:
  315.    P. L. Olympia
  316.    Darwin Systems, Inc.
  317.    17 Thorburn Road
  318.    Gaithersburg, MD 20878    301-251-0497 (Voice)
  319.  
  320.  
  321.  
  322.  
  323. <M>ainMenu  <P>rev  <N>ext  <D>elete  <C>ontinue.  Your choice?  C
  324. ----------------------------------------------------------------------------
  325.  
  326.      The  second line contains the item's key.  And most of the screen 
  327. contains the first 18 lines of the item.   You may edit the key or any 
  328. of the item's data displayed on the screen.  All your cursor pad  keys 
  329. are  active,  including  DEL and INS as well as the WordStar  commands 
  330. CTRL-Y (delete line),  CTRL-V (same as INS),  CTRL-G (delete character 
  331. at cursor).
  332.  
  333.      Note the prompt at the bottom of the screen:
  334.  
  335.  M - Returns you to the MainMenu, discarding any changes you have made
  336.  
  337.  P - Retrieves the previous item (before this one) that satisfies  the 
  338.      selection  criteria.  If there is no previous item,  or the  last 
  339.      item  you just edited is farther down in the filing cabinet  than
  340.      the one on display, you return to the Main Menu.
  341.  
  342.  N - Retrieves the next item satisfying the selection criteria.
  343.  
  344.  D - Deletes this item from the filing cabinet.   The program will ask 
  345.      you  to  confirm this action,  then marks the item for  deletion. 
  346.      Items so marked become physically removed from the filing cabinet 
  347.      with the R>EORGANIZE option of the Main Menu.
  348.  
  349.  C - Continues to the next 18 lines of the present item.  If there are 
  350.      no more data lines for this item,  the system moves on to display 
  351.      the next item that satisfies the selection criteria (same as  the 
  352.      N>ext option). If there are no more items, you return to the Main 
  353.      Menu.
  354.  
  355.      Note  that "C" is the default option of the Edit screen.  You can 
  356.      rapidly move forward through the filing cabinet by pressing  PgDn 
  357.      or CTRL-W.
  358.  
  359.  
  360. B>UILD OPTION
  361.  
  362.      When the Main Menu reappears,  press "B" to build your own filing 
  363. cabinet.   You  will be presented a configuration (setup) screen  like 
  364. this:
  365.  
  366. ----------------------------------------------------------------------------
  367. Cabinet:  FCSAMP.DBF                                        Today:  09/01/85
  368.  
  369.                          DEFAULT PARAMETERS
  370.  
  371.        Symbol delimiter for key -----------------   ~
  372.        (Changeable only during Build function)
  373.  
  374.        File Cabinet Name ------------------------   FCSAMP.DBF
  375.        File Cabinet Key Filename ----------------   FCSAMPK.DBF
  376.        2-char symbol to terminate data entry ----   ##
  377.        Find data output device (Screen/Printer) -   S
  378.        Export data file name --------------------   FCOUT.TXT
  379.  
  380. ----------------------------------------------------------------------------
  381.  
  382. NOTE:     The  system will accept fully qualified filenames  including 
  383.           drive. 
  384.  
  385.      The  symbol delimiter (default is ~) is used to tell  the  system 
  386. that  any line beginning with that symbol in a file being imported  is 
  387. intended to be a KEY line for the following data lines of an item.
  388.  
  389.      The  next  two  lines prompt you for the names of  the  new  file 
  390. cabinet you want to use or build.   They must be different names. They 
  391. may contain a drive specifier, and should contain a filetype (although 
  392. NOT necessary). If the filetype is omitted, it defaults to DBF.
  393.  
  394.      The  two-character  symbol (default ##) is used  during  keyboard 
  395. entry  of items in the filing cabinet to tell the system that you have 
  396. finished entering data for the item.  
  397.  
  398.      The default output device for F>ind data operation is the screen. 
  399. Change this to P if you want output to go to the printer.  You can  go 
  400. back and change this using the C>HANGE option of the Main Menu.
  401.  
  402.  
  403. A>DD OPTION
  404.  
  405.      After  you build your filing cabinet you need to add items to it. 
  406. You  may do this either with the I>MPORT option (from a text file)  or 
  407. A>DD option (from the keyboard).  When you press "A" at the Main Menu, 
  408. you will be presented with the following data entry screen:
  409.  
  410. ----------------------------------------------------------------------------
  411. Enter key expression below. Leave blank then PgDn returns to Main Menu
  412. __________________________________________________________________
  413.  
  414. Enter text in following lines. Terminate data entry with ##
  415. as the first chars in a blank line, then PgDn
  416.  
  417. _____________________________________________________________
  418. _____________________________________________________________
  419. _____________________________________________________________
  420. _____________________________________________________________
  421. _____________________________________________________________
  422. _____________________________________________________________
  423. _____________________________________________________________
  424. _____________________________________________________________
  425. _____________________________________________________________
  426.  
  427.  
  428.  
  429.  
  430. End data entry with ## at beginning of line. Then PgDn.
  431. Leave key line on top blank to return to Main Menu.
  432. ----------------------------------------------------------------------------
  433.  
  434.      On  the  first line,  enter any keys you want to assign  to  this 
  435. item.  You may enter them in any mix of upper or lower case or you may 
  436. elect to string all keys together (without intervening blanks).
  437.  
  438.      On  the  next 9 lines,  enter your item data.  If you  need  more 
  439. lines,  the system will continue to present you with a fresh set of  9 
  440. lines until you signify that you are done, by typing the end delimiter 
  441. (##  in this case) at the beginning of any line.   All lines following 
  442. this one will be discarded - since the ## says "This is the end, bud."
  443.  
  444.      You  may  use ## in any item line so long as that line  does  NOT 
  445. begin with that delimiter.
  446.  
  447.      The system will now give you a new data entry screen.  If you  no 
  448. longer  have any items to enter,  just PgDn and the system returns you 
  449. to the Main Menu.
  450.  
  451. NOTE:     I CANNOT OVEREMPHASIZE THE FACT THAT YOU MUST TERMINATE YOUR 
  452.           DATA  ENTRY FOR AN ITEM'S DATA BY PUTTING IN  THE  DELIMITER 
  453.           SYMBOL (DEFAULT IS ##) AT THE BEGINNING OF A DATA ENTRY LINE 
  454.           FOLLOWING THE LAST LINE OF THE ITEM'S DATA.
  455.  
  456.  
  457. I>MPORT OPTION
  458.  
  459.      Use  this  to add data to the filing cabinet from an  ASCII  file 
  460. created elsewhere.  The system will ask you for the name of the import 
  461. file. You may specify drive or filetype.
  462.  
  463.      The  import  file must begin with a line  containing  the  symbol 
  464. delimiter (default ~) to signify a KEY line.  All lines following this 
  465. KEY line until the next KEY line is encountered (or until end of file) 
  466. will be the data lines for this item.
  467.  
  468.  
  469. C>HANGE OPTION
  470.  
  471.      Use  this  to change any of your  operating  environments,  e.g., 
  472. close  the  present filing cabinet and work on  a  different  one,  or 
  473. change the output destination to printer or screen.
  474.  
  475.  
  476. EX<P>ORT OPTION
  477.  
  478.      Use  this  to output selected items to a disk file named  in  the 
  479. configuration  screen.   This  is often used to send data to  a  word-
  480. processor for inclusion in documents.
  481.  
  482.  
  483. R>EORGANIZE OPTION
  484.  
  485.      Use  this  to  physically remove deleted items  from  the  filing 
  486. cabinet,  or  to fix a filing cabinet whose keys have become messed up 
  487. for one reason or another.
  488.  
  489.           
  490. And finally ...
  491.  
  492.  
  493. E<X>IT OPTION
  494.  
  495.      Use  this to exit the program and return to DOS.  The system will 
  496. give you a 2-second animated bye-bye screen.
  497.  
  498.      And speaking of bye-bye ...
  499.  
  500.  
  501. ----------------------------------------------------------------------------
  502.           TH' TH' TH' THAT'S ALL FOLKS ...
  503. ----------------------------------------------------------------------------
  504.